.. include:: ../variables.rst
.. _custom-audit-permissions:

Permissions
===========

The Permissions screen allows administrators to control access to individual custom audits.
To access Permissions navigate to :blue:`Custom Audits` | :blue:`Permissions`.

.. figure:: /images/customaudits/lightmode/custom-audit-permission-list.png
   :align: center
   :width: 100 %

|br|

Summary cards at the top display the total number of permissions, the number of active permissions,
the number of user-based permissions, and the number of role-based permissions.

Use the search bar and filter drop downs to locate permissions by audit, type, or status.

Permission Types
----------------

Permissions can be assigned to individual users or to roles:

* **User-Based** -- Permissions assigned directly to a specific user
* **Role-Based** -- Permissions assigned to a role, applying to all users in that role

Permission Matrix
-----------------

Each permission entry controls access through the following actions:

.. list-table::
   :widths: 20 80
   :header-rows: 1
   :align: center
   :width: 100 %

   * - Action
     - Description

   * - View
     - Allows the assignee to view the audit and its results.

   * - Edit
     - Allows the assignee to modify the audit structure and settings.

   * - Submit
     - Allows the assignee to submit completed audit responses.

   * - Approve
     - Allows the assignee to approve submitted audit responses.

   * - Delete
     - Allows the assignee to delete audit responses.

Adding a Permission
-------------------

To add a new permission click the :blue:`+ Add Permission` button. Select the audit, the assignee
(user or role), and configure the desired access levels.

Exporting Permissions
---------------------

Click the :blue:`Export` button to export the permission list for backup or sharing purposes.